feat: add legacy beta map compatibility interfaces by jenn-le · Pull Request #27240 · microsoft/FluidFramework

jenn-le · 2026-05-06T05:25:32Z

Description

Adds legacy beta map compatibility interfaces for APIs that need to align with JavaScript Map while still using Fluid's map abstraction.

This change introduces FluidMapLegacy in @fluidframework/core-interfaces/legacy. It extends FluidMap and only adds the legacy/built-in Map-style members needed for compatibility: clear, delete returning boolean, set returning this, and a forEach callback typed with FluidMapLegacy.

This also adds IDirectoryBeta and ISharedMapBeta in @fluidframework/map/legacy. The existing IDirectory and ISharedMap interfaces are unchanged and continue to extend the built-in Map; the new beta variants provide an opt-in shape that consumes FluidMapLegacy.

github-actions · 2026-05-06T05:26:34Z

Hi! Thank you for opening this PR. Want me to review it?

Based on the diff (182 lines, 10 files), I've queued these reviewers:

Correctness — logic errors, race conditions, lifecycle issues
Security — vulnerabilities, secret exposure, injection
API Compatibility — breaking changes, release tags, type design
Performance — algorithmic regressions, memory leaks
Testing — coverage gaps, hollow tests

How this works

Adjust the reviewer set by ticking/unticking boxes above. Reviewer toggles alone don't trigger anything.
Tick Start review below to dispatch the review fleet.
After review finishes, tick Start review again to request another run — it auto-resets after each dispatch.
This comment updates as new commits land; your reviewer selections are preserved.
Start review

Copilot

Pull request overview

Adds new legacy/beta “Map-compatible” typing surfaces so legacy DDS APIs can align with JavaScript Map signatures while still participating in Fluid’s stable FluidMap abstraction shape.

Changes:

Introduces FluidMapLegacy<K, V> in @fluidframework/core-interfaces (legacy/beta) to preserve Map-style mutator returns (delete(): boolean, set(): this) and clear().
Adds IDirectoryBeta and ISharedMapBeta (legacy/beta) that replace the built-in Map inheritance with FluidMapLegacy via Omit<..., keyof Map<...>>.
Adds compile-time type tests and updates API reports + changeset to validate/ship the new legacy surfaces.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
packages/dds/map/src/test/types/fluidMapLegacyTypes.ts	Adds type-level assertions validating `*Beta` assignability to `FluidMapLegacy` and `Map`.
packages/dds/map/src/interfaces.ts	Introduces `IDirectoryBeta` / `ISharedMapBeta` using `FluidMapLegacy` for map-like API shape.
packages/dds/map/src/index.ts	Re-exports the new beta interfaces from the package surface (gated by `@legacy @beta` tags).
packages/dds/map/api-report/map.legacy.beta.api.md	Updates legacy beta API report to include the new beta interfaces.
packages/common/core-interfaces/src/test/types/fluidMapTypes.ts	Adds type-level assertions for `FluidMapLegacy` compatibility with `FluidMap` and `Map`.
packages/common/core-interfaces/src/index.ts	Exports `FluidMapLegacy` from the package index (release-tag filtered into legacy typings).
packages/common/core-interfaces/src/fluidMap.ts	Defines `FluidMapLegacy<K, V>` (legacy/beta) extending `FluidMap` with `Map`-style mutators.
packages/common/core-interfaces/api-report/core-interfaces.legacy.beta.api.md	Updates legacy beta API report to include `FluidMapLegacy`.
packages/common/core-interfaces/api-report/core-interfaces.legacy.alpha.api.md	Updates legacy alpha API report to include `FluidMapLegacy` (alpha rollup includes beta surfaces).
.changeset/lazy-lies-enjoy.md	Adds changeset bumping `@fluidframework/core-interfaces` and `@fluidframework/map` for the new legacy/beta types.

Co-authored-by: Copilot <copilot@github.com>

github-actions · 2026-05-06T22:37:36Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  288641 links
    1922 destination URLs
    2172 URLs ignored
       0 warnings
       0 errors

CraigMacomber · 2026-05-07T16:51:20Z

+ *
+ * @sealed @legacy @beta
+ */
+export interface FluidMapLegacy<K, V> extends FluidMap<K, V> {


Do we plan to ever use this for anything other than shared map and shared directory? If not, it should probably be in that package.

If you do move this, you should be able to inline the questionable get and set APIs those maps use here, which would simplify things a bit.

CraigMacomber · 2026-05-07T16:57:02Z

+	 *
+	 * @returns The map itself.
+	 */
+	set(key: K, value: V): this;


Don't we override/omit this in all cases that use this interface? Maybe we don't need to state it here?

add FluidMapLegacy and beta interfaces to use it

827caf5

Copilot AI review requested due to automatic review settings May 6, 2026 05:25

jenn-le requested review from a team as code owners May 6, 2026 05:25

Copilot started reviewing on behalf of jenn-le May 6, 2026 05:26 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

jenn-le commented May 6, 2026

View reviewed changes

Comment thread packages/dds/map/src/interfaces.ts Outdated

CraigMacomber reviewed May 6, 2026

View reviewed changes

Comment thread packages/dds/map/src/interfaces.ts Outdated

CraigMacomber reviewed May 6, 2026

View reviewed changes

Comment thread packages/dds/map/src/test/types/fluidMapLegacyTypes.ts Outdated

pr feedback

4755fd6

Co-authored-by: Copilot <copilot@github.com>

CraigMacomber reviewed May 7, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add legacy beta map compatibility interfaces#27240

feat: add legacy beta map compatibility interfaces#27240
jenn-le wants to merge 2 commits intomicrosoft:mainfrom
jenn-le:fluid-map-legacy

jenn-le commented May 6, 2026

Uh oh!

github-actions Bot commented May 6, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 6, 2026

Uh oh!

CraigMacomber May 7, 2026

Uh oh!

CraigMacomber May 7, 2026

Uh oh!

CraigMacomber May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jenn-le commented May 6, 2026

Description

Uh oh!

github-actions Bot commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 6, 2026

linkcheck output

Uh oh!

CraigMacomber May 7, 2026

Choose a reason for hiding this comment

Uh oh!

CraigMacomber May 7, 2026

Choose a reason for hiding this comment

Uh oh!

CraigMacomber May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented May 6, 2026 •

edited

Loading